home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-06 / bt515.exe / BUTNLM / README.DOC < prev   
Text File  |  1992-01-02  |  6KB  |  139 lines
  1.                 README FOR BTRIEVE's BUTIL (NLM) v5.15a RELEASE
  2.  
  3. This README file of BUTNLM.ZIP accompanies the released version of BUTIL NLM
  4. v5.15a.  The following files are included:
  5.  
  6.                    README   DOC     1573   1-02-92  10:38a
  7.                    BUTIL    NLM    64489   7-09-91  10:10a
  8.  
  9.  
  10. ** May 9, 1991 **
  11.  
  12. Version 5.15a
  13.  
  14. BUTIL.NLM is a utility which contains a set of commands that allow Btrieve
  15. users to create, maintain and recover Btrieve files at the server.  BUTIL.NLM
  16. supports 10 of the commands that are implemented in BUTIL.EXE.  The
  17. following is a list of commands that are available and a short description
  18. of each:
  19.  
  20.   * Clone
  21.     command format: Load Butil -Clone <New File> <Existing File> [-o<Owner>]
  22.  
  23.     The Clone command creates a new, empty Btrieve file with the same file
  24.     structure as an existing file.
  25.  
  26.   * Copy
  27.     command format: Load Butil -Copy  <Input File> <Output File> [-o<OwnerIn>
  28.                     [ -O <OwnerOut>]]
  29.  
  30.     The Copy command copies the contents of one Btrieve file to another.
  31.  
  32.   * Create
  33.     command format: Load Butil -Create <New File> <Description File>
  34.  
  35.     The Create command builds an empty Btrieve file using the structure
  36.     specified in a description file.
  37.  
  38.   * Drop
  39.     command format: Load Butil -Drop <Btrieve File> <Key Number> [-o<Owner>]
  40.  
  41.     The Drop command is used to remove a supplemental index from a Btrieve
  42.     file.
  43.  
  44.   * Index
  45.     command format: Load Butil -Index <Btrieve File> <Index File>
  46.                     <Description File> [-o<Owner>]
  47.  
  48.     The Index command builds an external index file based on a field that
  49.     had not been specified as a key before.
  50.  
  51.   * Load
  52.     command format: Load Butil -Load <Input File> <Btrieve File> [-o<Owner>]
  53.  
  54.     The Load command allows you to insert records from a sequential file
  55.     into a Btrieve file.
  56.  
  57.   * Recover
  58.     command format: Load Butil -Recover <Btrieve File> <Output File> [-o<Owner>]
  59.  
  60.     The Recover command reads records from a Btrieve file and writes them to a
  61.     sequential file that is compatible with the Load command.
  62.  
  63.   * Save
  64.     command format: Load Butil -Save <Btrieve File> <Output File> [<Y|N>
  65.                     <Index File> | <Key Number>] [-o<Owner>]
  66.  
  67.     The Save command allows you to retrieve records from a Btrieve file by a
  68.     specified index path, and creates a sequential file that is compatible
  69.     with the Load command.
  70.  
  71.   * Sindex
  72.     command format: Load Butil -Sindex <Btrieve File> <Description File>
  73.                     [-o<Owner>]
  74.  
  75.     The Sindex command creates a supplemental index for an existing Btrieve
  76.     file.
  77.  
  78.   * Stat
  79.     command format: Load Butil -Stat <Btrieve File> [-o<Owner>]
  80.  
  81.     The Stat command returns characteristics and statistics about a Btrieve
  82.     file.
  83.  
  84. The command line:
  85.     Load Butil -Command Parameters
  86. loads the NLM, executes the operation specified and unloads the NLM.  You
  87. can either execute these commands from the console prompt, or enter them
  88. into a NetWare Command File(NCF).
  89.  
  90. It is important to specify the complete path, including the volume name
  91. on the command line or in the NCF file.  BUTIL.NLM will return non-zero
  92. status (unsuccessful operation), when a complete path is not specified.
  93. For example, the following command will create a file called MyFile.Btr
  94. in the Sys: volume under the Test subdirectory using description file
  95. MyFile.des:
  96.  
  97.   Load Butil -create Sys:\Test\MyFile.btr Sys:\Test\MyFile.des
  98.  
  99. If a NCF file is used to execute BUTIL operations, the file can only contain
  100. one BUTIL command.  In other words, to recover a damaged Btrieve file using
  101. Recover and Load commands, you need to have two NCF files; one for the
  102. Recover command and one for the Load command.  This is because the first
  103. operation loads the NLM and executes the command.  Meanwhile, the second
  104. BUTIL operation tries to load the NLM while the first one is still running.
  105. In this case, the second attempt to load the BUTIL NLM will result with the
  106. error "This module is already loaded and cannot be loaded more than once".
  107.  
  108. There is no advantage for running BUTIL.NLM compared to BUTIL.EXE in many
  109. cases, such as Create, Stat and Drop.  It might even be more convenient to
  110. run BUTIL at the workstation for most of the operations.  However, it is
  111. much faster to recover files using the NLM version.
  112.  
  113. The BUTIL.NLM runs under the following combinations:
  114.  
  115.     1.   Netware version 3.10 with Btrieve version 5.10.
  116.     2.   Netware version 3.10 with Btrieve version 5.15.
  117.     3.   Netware version 3.11 with Btrieve version 5.15.
  118.  
  119.  
  120. *****************************************************************
  121.                     DISCLAIMER
  122.  
  123. Novell, Inc. makes no representations or warranties with respect to
  124. any NetWare software, and specifically disclaims any express or
  125. implied warranties of merchantability, title, or fitness for a
  126. particular purpose.
  127.  
  128. Distribution of any NetWare software is forbidden without the
  129. express written consent of Novell, Inc.  Further, Novell reserves
  130. the right to discontinue distribution of any NetWare software.
  131.  
  132. Novell is not responsible for lost profits or revenue, loss of use
  133. of the software, loss of data, costs of re-creating lost data, the
  134. cost of any substitute equipment or program, or claims by any party
  135. other than you.  Novell strongly recommends a backup be made before
  136. any software is installed.   Technical support for this software
  137. may be provided at the discretion of Novell.
  138. *****************************************************************
  139.